/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.lucene.analysis.miscellaneous;

import org.apache.lucene.util.Attribute;

/**
 * Provides statistics useful for detecting duplicate sections of text
 */
public interface DuplicateSequenceAttribute extends Attribute {
    /**
     * @return The number of times this token has been seen previously as part
     *         of a sequence (counts to a max of 255)
     */
    short getNumPriorUsesInASequence();

    void setNumPriorUsesInASequence(short len);
}